/*
 *  Copyright 2005 Blandware (http://www.blandware.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.blandware.atleap.webapp.action.forum.forum;

import com.blandware.atleap.common.Constants;
import com.blandware.atleap.common.ForumModuleConstants;
import com.blandware.atleap.common.parsers.html.HTMLPlainTextExtractor;
import com.blandware.atleap.common.util.ConvertUtil;
import com.blandware.atleap.model.forum.Forum;
import com.blandware.atleap.search.SearchManager;
import com.blandware.atleap.service.exception.BeanAlreadyExistsException;
import com.blandware.atleap.service.forum.ForumManager;
import com.blandware.atleap.webapp.action.core.BaseAction;
import com.blandware.atleap.webapp.form.forum.ForumForm;
import com.blandware.atleap.webapp.util.core.CacheUtil;
import com.blandware.atleap.webapp.util.core.WebappUtil;
import com.blandware.atleap.webapp.util.forum.ForumModuleWebConstants;
import org.apache.commons.validator.GenericValidator;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;
import org.springframework.orm.ObjectOptimisticLockingFailureException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

/**
 * <p>Updates a forum.</p>
 * <p><a href="UpdateForumAction.java.html"><i>View source</i></a></p>
 *
 * @author Roman Puchkovskiy <a href="mailto:roman.puchkovskiy@blandware.com">
 *         &lt;roman.puchkovskiy@blandware.com&gt;</a>
 * @version $Revision: 1.5 $ $Date: 2008/04/29 17:51:50 $
 * @struts.action path="/forum/forum/update"
 * name="forumForm"
 * scope="request"
 * input="inputForward"
 * validate="true"
 * roles="forum-forum-update"
 * @struts.action-forward name="inputForward"
 * path=".forum.forum.update"
 * @struts.action-forward name="listForums"
 * path="/forum/forum/list.do"
 * redirect="true"
 * @struts.action-forward name="callUpdateForum"
 * path="/forum/forum/callUpdate.do"
 * redirect="false"
 * @struts.action-forward name="unsatisfiable"
 * path="/forum/forum/list.do"
 */
public final class UpdateForumAction extends BaseAction {
	/**
	 * @param mapping  The ActionMapping used to select this instance
	 * @param form     The optional ActionForm bean for this request (if any)
	 * @param request  The HTTP request we are proceeding
	 * @param response The HTTP response we are creating
	 * @return an ActionForward instance describing where and how
	 *         control should be forwarded, or null if response
	 *         has already been completed
	 */
	public ActionForward execute(ActionMapping mapping, ActionForm form,
	                             HttpServletRequest request, HttpServletResponse response) throws Exception {

		if ( !isCancelled(request) ) {

			ForumForm forumForm = (ForumForm) form;
            HttpSession session = request.getSession();

            Long parentId;
            parentId = (Long) session.getAttribute(ForumModuleWebConstants.FORUM_PARENT_ID_KEY);

            Long forumId;
            if ( !GenericValidator.isBlankOrNull(forumForm.getId()) ) {
                forumId = Long.valueOf(forumForm.getId());
            } else {
                if ( log.isWarnEnabled() ) {
                    log.warn("Missing forum ID. Returning to list...");
                }
                return mapping.findForward("listForums");
            }

			ForumManager forumManager = (ForumManager) getBean(ForumModuleConstants.FORUM_MANAGER_BEAN);
            Forum forum = forumManager.retrieveForum(forumId);

            if ( forum == null ) {
                // forum not found. it might be deleted by someone else
                ActionMessages errors = new ActionMessages();
                errors.add("forumNotFound", new ActionMessage("forum.forum.errors.notFound"));
                saveErrors(request, errors);
                return mapping.findForward("listForums");
            }

            WebappUtil.copyProperties(forum, forumForm, request);

            String title = forumForm.getSingleTitle();

			if ( GenericValidator.isBlankOrNull(title) ) {
				// title must be specified
				ActionMessages errors = new ActionMessages();
				errors.add("title", new ActionMessage("core.commons.errors.required", getMessage(request, "forum.forum.form.title")));
				saveErrors(request, errors, false);
				saveToken(request);
				return mapping.getInputForward();
			}

            Map titleMap = new HashMap();
            titleMap.put(forum.getLanguage().getIdentifier(), title);
            forum.setTitle(titleMap);

            String annotation = forumForm.getAnnotation();

            // get all refs
            HTMLPlainTextExtractor extractor = new HTMLPlainTextExtractor();
            Set refs = new HashSet();
            InputStream bodyIS = new ByteArrayInputStream(ConvertUtil.convertToByteArray(annotation));
            refs.addAll(extractor.extractAllRefs(bodyIS, Constants.DEFAULT_ENCODING));

            Map linkedObjects = WebappUtil.mapObjectsToRefs(refs, request.getSession().getServletContext(), request.getContextPath());

			try {
                forum.setLastUpdatedDatetime(new Date());
                forumManager.updateForum(forum, parentId, linkedObjects);

                if ( forum.getActive().booleanValue() ) {
                    // index forum
                    SearchManager searchManager = SearchManager.getInstance(request.getSession().getServletContext());
                    searchManager.reIndexPage(forum, request);
                }

                CacheUtil cacheUtil = CacheUtil.getInstance(request);
                cacheUtil.flushLocalizableFieldValueCache(forumId);
			} catch ( BeanAlreadyExistsException e ) {
				// forum already exists
				ActionMessages errors = new ActionMessages();
				errors.add("forumAlreadyExists", new ActionMessage("forum.forum.errors.alreadyExists"));
				saveErrors(request, errors);
				saveToken(request);
				return mapping.getInputForward();
			} catch ( ObjectOptimisticLockingFailureException e ) {
                // forum was updated or deleted by another transaction
                ActionMessages errors = new ActionMessages();
                errors.add("updateFailed", new ActionMessage("forum.forum.errors.updateFailed"));
                saveErrors(request, errors);
                return mapping.findForward("callUpdateForum");
            }
        }

        return mapping.findForward("listForums");
	}
}
